<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class YahooSession</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name"><img src="../media/images/Class_logo.png"
														alt=" Class"
														title=" Class"
														style="vertical-align: middle"> YahooSession</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Defines a session between an application and the Yahoo! platform.</p>
<p class="description"><p>Defines a session between an application and the Yahoo! platform.</p></p>
		<p class="notes">
			Located in <a class="field" href="_Yahoo.inc.html">/Yahoo.inc</a> (line <span class="field"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a222">222</a></span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>



	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																																																																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$accessToken" title="details" class="var-name">$accessToken</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$application" title="details" class="var-name">$application</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$applicationId" title="details" class="var-name">$applicationId</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$client" title="details" class="var-name">$client</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$consumer" title="details" class="var-name">$consumer</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$guid" title="details" class="var-name">$guid</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																																																																								<div class="method-definition">
					<img src="../media/images/Constructor.png" alt=" "/>
											<span class="method-result">YahooSession</span>
										<a href="#YahooSession" title="details" class="method-name">YahooSession</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$consumer</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$accessToken</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$applicationId</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#accessTokenExpired" title="details" class="method-name">accessTokenExpired</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$accessToken</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$consumer</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$applicationId</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$sessionStore</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">boolean</span>
										<a href="#checkSession" title="details" class="method-name">checkSession</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">&$sessionType</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$sessionStore</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#clearSession" title="details" class="method-name">clearSession</a>
											([<span class="var-type">$sessionStore</span>&nbsp;<span class="var-name">$sessionStore</span> = <span class="var-default">NULL</span>])
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">stdclass</span>
										<a href="#createAuthorizationUrl" title="details" class="method-name">createAuthorizationUrl</a>
											(<span class="var-type">$consumerKey</span>&nbsp;<span class="var-name">$consumerKey</span>, <span class="var-type">$consumerSecret</span>&nbsp;<span class="var-name">$consumerSecret</span>, [<span class="var-type">$callback</span>&nbsp;<span class="var-name">$callback</span> = <span class="var-default">NULL</span>], [<span class="var-type">$sessionStore</span>&nbsp;<span class="var-name">$sessionStore</span> = <span class="var-default">NULL</span>])
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#getAccessToken" title="details" class="method-name">getAccessToken</a>
										()
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#getApplicationId" title="details" class="method-name">getApplicationId</a>
										()
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#getConsumer" title="details" class="method-name">getConsumer</a>
										()
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result"><a href="../yos-social-php/YahooUser.html">YahooUser</a></span>
										<a href="#getOwner" title="details" class="method-name">getOwner</a>
										()
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result"><a href="../yos-social-php/YahooUser.html">YahooUser</a></span>
										<a href="#getSessionedUser" title="details" class="method-name">getSessionedUser</a>
										()
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result"><a href="../yos-social-php/YahooUser.html">YahooUser</a></span>
										<a href="#getUser" title="details" class="method-name">getUser</a>
											(<span class="var-type">$guid</span>&nbsp;<span class="var-name">$guid</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">boolean</span>
										<a href="#hasSession" title="details" class="method-name">hasSession</a>
											(<span class="var-type">$consumerKey</span>&nbsp;<span class="var-name">$consumerKey</span>, <span class="var-type">$consumerSecret</span>&nbsp;<span class="var-name">$consumerSecret</span>, [<span class="var-type">$applicationId</span>&nbsp;<span class="var-name">$applicationId</span> = <span class="var-default">NULL</span>], [<span class="var-type">$sessionStore</span>&nbsp;<span class="var-name">$sessionStore</span> = <span class="var-default">NULL</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$verifier</span> = <span class="var-default">NULL</span>])
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#initSession" title="details" class="method-name">initSession</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$consumerKey</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$consumerSecret</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$applicationId</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$redirect</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$callback</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$sessionStore</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$verifier</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#initSessionFromYAP" title="details" class="method-name">initSessionFromYAP</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$consumerKey</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$consumerSecret</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$appid</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">The</span>
										<a href="#query" title="details" class="method-name">query</a>
											(<span class="var-type">$yql</span>&nbsp;<span class="var-name">$yql</span>, [<span class="var-type">$env</span>&nbsp;<span class="var-name">$env</span> = <span class="var-default">NULL</span>])
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#redirectForAuthorization" title="details" class="method-name">redirectForAuthorization</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$consumerKey</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$consumerSecret</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$callback</span> = <span class="var-default">NULL</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$sessionStore</span> = <span class="var-default">NULL</span>])
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result"><a href="../yos-social-php/YahooSession.html">YahooSession</a></span>
										<a href="#requireSession" title="details" class="method-name">requireSession</a>
											(<span class="var-type">$consumerKey</span>&nbsp;<span class="var-name">$consumerKey</span>, <span class="var-type">$consumerSecret</span>&nbsp;<span class="var-name">$consumerSecret</span>, [<span class="var-type">$applicationId</span>&nbsp;<span class="var-name">$applicationId</span> = <span class="var-default">NULL</span>], [<span class="var-type">$callback</span>&nbsp;<span class="var-name">$callback</span> = <span class="var-default">NULL</span>], [<span class="var-type">$sessionStore</span>&nbsp;<span class="var-name">$sessionStore</span> = <span class="var-default">NULL</span>], [<span class="var-type">$verifier</span>&nbsp;<span class="var-name">$verifier</span> = <span class="var-default">NULL</span>])
									</div>
											</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			
<a name="var$accessToken" id="$accessToken"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$accessToken</span>
			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a236">236</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">private:</span> </li>
			</ul>
	
	
		
		

</div>
<a name="var$application" id="$application"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$application</span>
			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a251">251</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">private:</span> </li>
			</ul>
	
	
		
		

</div>
<a name="var$applicationId" id="$applicationId"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$applicationId</span>
			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a241">241</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">private:</span> </li>
			</ul>
	
	
		
		

</div>
<a name="var$client" id="$client"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$client</span>
			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a246">246</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">private:</span> </li>
			</ul>
	
	
		
		

</div>
<a name="var$consumer" id="$consumer"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$consumer</span>
			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a231">231</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">private:</span> </li>
			</ul>
	
	
		
		

</div>
<a name="var$guid" id="$guid"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$guid</span>
			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a226">226</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">private:</span> </li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
														<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodYahooSession" id="YahooSession"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Constructor.png" />
		<span class="method-title">Constructor YahooSession</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a256">256</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">private:</span> </li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">YahooSession</span>
		<span class="method-name">
			YahooSession
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$consumer</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$accessToken</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$applicationId</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$consumer</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$accessToken</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$applicationId</span>			</li>
				</ul>
		
			
	</div>
<a name="methodaccessTokenExpired" id="accessTokenExpired"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">accessTokenExpired</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a657">657</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">private:</span> </li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			accessTokenExpired
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$accessToken</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$consumer</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$applicationId</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$sessionStore</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$accessToken</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$consumer</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$applicationId</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$sessionStore</span>			</li>
				</ul>
		
			
	</div>
<a name="methodcheckSession" id="checkSession"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">checkSession</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a706">706</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">return:</span> True if a session is present, false otherwise.</li>
				<li><span class="field">private:</span> Checks to see if the current PHP page request has a session and, if so, indicates what type of session is present.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			checkSession
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">&$sessionType</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$sessionStore</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">&$sessionType</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$sessionStore</span>			</li>
				</ul>
		
			
	</div>
<a name="methodclearSession" id="clearSession"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">clearSession</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a361">361</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Destroys the current session, effectively logging out the current user.</p>
<p class="description"><p>Destroys the current session, effectively logging out the current user.</p></p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			clearSession
		</span>
					([<span class="var-type">$sessionStore</span>&nbsp;<span class="var-name">$sessionStore</span> = <span class="var-default">NULL</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$sessionStore</span>
				<span class="var-name">$sessionStore</span><span class="var-description">: The session store implementation to clear. See                      YahooSessionStore for more information. If no                      session store is provided, clearSession will                      instantiate a NativeSessionStore and use that.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodcreateAuthorizationUrl" id="createAuthorizationUrl"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">createAuthorizationUrl</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a464">464</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Creates authorization URLs, allowing applications to manage their user experience when the user needs to be sent to Yahoo! to authorize the application to access their account.</p>
<p class="description"><p>Creates authorization URLs, allowing applications to manage their user experience when the user needs to be sent to Yahoo! to authorize the application to access their account.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> A PHP object with two properties: &quot;urlWithCallback&quot;                  and &quot;urlWithoutCallback&quot;. This allows the application                  to mix and match authorizations that do and don't                  have callbacks in the URLs. urlWithoutCallback is                  useful for JavaScript popup windows while                  urlWithCallback is useful for normal &lt;a href&gt;                  tags.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">stdclass</span>
		<span class="method-name">
			createAuthorizationUrl
		</span>
					(<span class="var-type">$consumerKey</span>&nbsp;<span class="var-name">$consumerKey</span>, <span class="var-type">$consumerSecret</span>&nbsp;<span class="var-name">$consumerSecret</span>, [<span class="var-type">$callback</span>&nbsp;<span class="var-name">$callback</span> = <span class="var-default">NULL</span>], [<span class="var-type">$sessionStore</span>&nbsp;<span class="var-name">$sessionStore</span> = <span class="var-default">NULL</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$consumerKey</span>
				<span class="var-name">$consumerKey</span><span class="var-description">: The OAuth consumer key.</span>			</li>
					<li>
				<span class="var-type">$consumerSecret</span>
				<span class="var-name">$consumerSecret</span><span class="var-description">: The OAuth consumer key secret.</span>			</li>
					<li>
				<span class="var-type">$callback</span>
				<span class="var-name">$callback</span><span class="var-description">: The callback URL to redirect the user to after                  they verify the application access. If no callback                  is provided, the current page URL will be used.                  Use the &quot;oob&quot; callback for desktop clients or for                  web clients where no callback should be used.</span>			</li>
					<li>
				<span class="var-type">$sessionStore</span>
				<span class="var-name">$sessionStore</span><span class="var-description">: The session store implementation to use. See                      YahooSessionStore for more information. If no                      session store is provided, createAuthorizationUrl                      will instantiate a NativeSessionStore and use that.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetAccessToken" id="getAccessToken"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">getAccessToken</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a279">279</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">private:</span> </li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getAccessToken
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetApplicationId" id="getApplicationId"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">getApplicationId</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a286">286</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">private:</span> </li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getApplicationId
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetConsumer" id="getConsumer"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">getConsumer</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a272">272</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">private:</span> </li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getConsumer
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetOwner" id="getOwner"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">getOwner</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a306">306</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the user who owns the application install.</p>
<p class="description"><p>Gets the user who owns the application install. Only valid when viewed in YAP, otherwise will default to the logged-in user.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> The currently sessioned YahooUser.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../yos-social-php/YahooUser.html">YahooUser</a></span>
		<span class="method-name">
			getOwner
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetSessionedUser" id="getSessionedUser"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">getSessionedUser</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a295">295</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the currently sessioned user.</p>
<p class="description"><p>Gets the currently sessioned user.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> The currently sessioned YahooUser.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../yos-social-php/YahooUser.html">YahooUser</a></span>
		<span class="method-name">
			getSessionedUser
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetUser" id="getUser"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">getUser</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a321">321</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets the user indicated by the GUID given.</p>
<p class="description"><p>Gets the user indicated by the GUID given.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> The user indicated by the GUID given.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../yos-social-php/YahooUser.html">YahooUser</a></span>
		<span class="method-name">
			getUser
		</span>
					(<span class="var-type">$guid</span>&nbsp;<span class="var-name">$guid</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$guid</span>
				<span class="var-name">$guid</span><span class="var-description">: The GUID of the user to get.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodhasSession" id="hasSession"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">hasSession</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a388">388</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks to see if there is a session in this PHP page request.</p>
<p class="description"><p>Checks to see if there is a session in this PHP page request. Doesn't cause any redirects for the user to log in, for that you should call requireSession().</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> True if a session is present, false otherwise.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			hasSession
		</span>
					(<span class="var-type">$consumerKey</span>&nbsp;<span class="var-name">$consumerKey</span>, <span class="var-type">$consumerSecret</span>&nbsp;<span class="var-name">$consumerSecret</span>, [<span class="var-type">$applicationId</span>&nbsp;<span class="var-name">$applicationId</span> = <span class="var-default">NULL</span>], [<span class="var-type">$sessionStore</span>&nbsp;<span class="var-name">$sessionStore</span> = <span class="var-default">NULL</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$verifier</span> = <span class="var-default">NULL</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$consumerKey</span>
				<span class="var-name">$consumerKey</span><span class="var-description">: The OAuth consumer key.</span>			</li>
					<li>
				<span class="var-type">$consumerSecret</span>
				<span class="var-name">$consumerSecret</span><span class="var-description">: The OAuth consumer key secret.</span>			</li>
					<li>
				<span class="var-type">$applicationId</span>
				<span class="var-name">$applicationId</span><span class="var-description">: The application ID, optional.</span>			</li>
					<li>
				<span class="var-type">$sessionStore</span>
				<span class="var-name">$sessionStore</span><span class="var-description">: The session store implementation to use. See                      YahooSessionStore for more information. If no                      session store is provided, clearSession will                      instantiate a NativeSessionStore and use that.</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$verifier</span>			</li>
				</ul>
		
			
	</div>
<a name="methodinitSession" id="initSession"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">initSession</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a543">543</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">private:</span> </li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			initSession
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$consumerKey</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$consumerSecret</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$applicationId</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$redirect</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$callback</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$sessionStore</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$verifier</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$consumerKey</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$consumerSecret</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$applicationId</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$redirect</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$callback</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$sessionStore</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$verifier</span>			</li>
				</ul>
		
			
	</div>
<a name="methodinitSessionFromYAP" id="initSessionFromYAP"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">initSessionFromYAP</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a495">495</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			initSessionFromYAP
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$consumerKey</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$consumerSecret</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$appid</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$consumerKey</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$consumerSecret</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$appid</span>			</li>
				</ul>
		
			
	</div>
<a name="methodquery" id="query"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">query</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a332">332</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Executes the given YQL query.</p>
<p class="description"><p>Executes the given YQL query.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> response or NULL if the request fails..</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">The</span>
		<span class="method-name">
			query
		</span>
					(<span class="var-type">$yql</span>&nbsp;<span class="var-name">$yql</span>, [<span class="var-type">$env</span>&nbsp;<span class="var-name">$env</span> = <span class="var-default">NULL</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$yql</span>
				<span class="var-name">$yql</span><span class="var-description">: The query to execute.</span>			</li>
					<li>
				<span class="var-type">$env</span>
				<span class="var-name">$env</span><span class="var-description">: A URL to a YQL environment file.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodredirectForAuthorization" id="redirectForAuthorization"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">redirectForAuthorization</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a339">339</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">private:</span> </li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			redirectForAuthorization
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$consumerKey</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$consumerSecret</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$callback</span> = <span class="var-default">NULL</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$sessionStore</span> = <span class="var-default">NULL</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$consumerKey</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$consumerSecret</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$callback</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$sessionStore</span>			</li>
				</ul>
		
			
	</div>
<a name="methodrequireSession" id="requireSession"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">requireSession</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__Yahoo.inc.html#a426">426</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Requires that there be a session in this PHP page request. a redirect for the user to log in, if necessary. requireSession() before any data is sent back to the user in order for the redirect to work.</p>
<p class="description"><p>Requires that there be a session in this PHP page request. Generates a redirect for the user to log in, if necessary. You must call requireSession() before any data is sent back to the user in order for the redirect to work.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> The current session or NULL if a session cannot                      be established.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../yos-social-php/YahooSession.html">YahooSession</a></span>
		<span class="method-name">
			requireSession
		</span>
					(<span class="var-type">$consumerKey</span>&nbsp;<span class="var-name">$consumerKey</span>, <span class="var-type">$consumerSecret</span>&nbsp;<span class="var-name">$consumerSecret</span>, [<span class="var-type">$applicationId</span>&nbsp;<span class="var-name">$applicationId</span> = <span class="var-default">NULL</span>], [<span class="var-type">$callback</span>&nbsp;<span class="var-name">$callback</span> = <span class="var-default">NULL</span>], [<span class="var-type">$sessionStore</span>&nbsp;<span class="var-name">$sessionStore</span> = <span class="var-default">NULL</span>], [<span class="var-type">$verifier</span>&nbsp;<span class="var-name">$verifier</span> = <span class="var-default">NULL</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$consumerKey</span>
				<span class="var-name">$consumerKey</span><span class="var-description">: The OAuth consumer key.</span>			</li>
					<li>
				<span class="var-type">$consumerSecret</span>
				<span class="var-name">$consumerSecret</span><span class="var-description">: The OAuth consumer key secret.</span>			</li>
					<li>
				<span class="var-type">$applicationId</span>
				<span class="var-name">$applicationId</span><span class="var-description">: The application ID, optional.</span>			</li>
					<li>
				<span class="var-type">$callback</span>
				<span class="var-name">$callback</span><span class="var-description">: The callback URL to redirect the user to after                  they verify the application access. If no callback                  is provided, the current page URL will be used.</span>			</li>
					<li>
				<span class="var-type">$sessionStore</span>
				<span class="var-name">$sessionStore</span><span class="var-description">: The session store implementation to use. See                      YahooSessionStore for more information. If no                      session store is provided, clearSession will                      instantiate a NativeSessionStore and use that.</span>			</li>
					<li>
				<span class="var-type">$verifier</span>
				<span class="var-name">$verifier</span><span class="var-description">: The oauth_verifier returned by the OAuth servers                  after authorization. Passing NULL indicates that                  authorization was completed previously or that                  requireSession() should look for oauth_verifier in                  the $_GET superglobal.</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>

	
	<p class="notes" id="credit">
		Documentation generated on Thu, 22 Oct 2009 12:54:52 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>